<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libBigWig: bwRTree_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libBigWig
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">bwRTree_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="bwValues_8h_source.html">bwValues.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a430220a665cfcc8c76e372dc8f221b2f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#a430220a665cfcc8c76e372dc8f221b2f">blockSize</a></td></tr>
<tr class="separator:a430220a665cfcc8c76e372dc8f221b2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f07bf1ea36552d70a59a1c7aea3a329"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#a5f07bf1ea36552d70a59a1c7aea3a329">nItems</a></td></tr>
<tr class="separator:a5f07bf1ea36552d70a59a1c7aea3a329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a5289849d34bc738f2d45e121f1c8b3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#a3a5289849d34bc738f2d45e121f1c8b3">chrIdxStart</a></td></tr>
<tr class="separator:a3a5289849d34bc738f2d45e121f1c8b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adde0db0e9555b457c074d1eacae1c02f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#adde0db0e9555b457c074d1eacae1c02f">baseStart</a></td></tr>
<tr class="separator:adde0db0e9555b457c074d1eacae1c02f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50c877d3f3a8a5994ccdfe58d2dd0e85"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#a50c877d3f3a8a5994ccdfe58d2dd0e85">chrIdxEnd</a></td></tr>
<tr class="separator:a50c877d3f3a8a5994ccdfe58d2dd0e85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a656f53ca34361b368fc3fd1710f0de42"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#a656f53ca34361b368fc3fd1710f0de42">baseEnd</a></td></tr>
<tr class="separator:a656f53ca34361b368fc3fd1710f0de42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a119af9ef30b2923ccb7e4ae8a6d3b501"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#a119af9ef30b2923ccb7e4ae8a6d3b501">idxSize</a></td></tr>
<tr class="separator:a119af9ef30b2923ccb7e4ae8a6d3b501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af339ad528e3ed973bd454123fbded262"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#af339ad528e3ed973bd454123fbded262">nItemsPerSlot</a></td></tr>
<tr class="separator:af339ad528e3ed973bd454123fbded262"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3e57a494e0c45d56dca1de0939e8197"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#aa3e57a494e0c45d56dca1de0939e8197">rootOffset</a></td></tr>
<tr class="separator:aa3e57a494e0c45d56dca1de0939e8197"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4566d3fdd23ac4918104d23c77a7ddb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbwRTreeNode__t.html">bwRTreeNode_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTree__t.html#ad4566d3fdd23ac4918104d23c77a7ddb">root</a></td></tr>
<tr class="separator:ad4566d3fdd23ac4918104d23c77a7ddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A header and index that points to an R-tree that in turn points to data blocks. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a656f53ca34361b368fc3fd1710f0de42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a656f53ca34361b368fc3fd1710f0de42">&#9670;&nbsp;</a></span>baseEnd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t bwRTree_t::baseEnd</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The last position on chrIdxEnd with an entry. </p>

</div>
</div>
<a id="adde0db0e9555b457c074d1eacae1c02f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adde0db0e9555b457c074d1eacae1c02f">&#9670;&nbsp;</a></span>baseStart</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t bwRTree_t::baseStart</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The first position on chrIdxStart with a value. </p>

</div>
</div>
<a id="a430220a665cfcc8c76e372dc8f221b2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a430220a665cfcc8c76e372dc8f221b2f">&#9670;&nbsp;</a></span>blockSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t bwRTree_t::blockSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The maximum number of children a node can have </p>

</div>
</div>
<a id="a50c877d3f3a8a5994ccdfe58d2dd0e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50c877d3f3a8a5994ccdfe58d2dd0e85">&#9670;&nbsp;</a></span>chrIdxEnd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t bwRTree_t::chrIdxEnd</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The index of the last chromosome with an entry. </p>

</div>
</div>
<a id="a3a5289849d34bc738f2d45e121f1c8b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a5289849d34bc738f2d45e121f1c8b3">&#9670;&nbsp;</a></span>chrIdxStart</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t bwRTree_t::chrIdxStart</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The index to the first chromosome described. </p>

</div>
</div>
<a id="a119af9ef30b2923ccb7e4ae8a6d3b501"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a119af9ef30b2923ccb7e4ae8a6d3b501">&#9670;&nbsp;</a></span>idxSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t bwRTree_t::idxSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This is actually the offset of the index rather than the size?!? Yes, it's completely redundant. </p>

</div>
</div>
<a id="a5f07bf1ea36552d70a59a1c7aea3a329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f07bf1ea36552d70a59a1c7aea3a329">&#9670;&nbsp;</a></span>nItems</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t bwRTree_t::nItems</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The total number of data blocks pointed to by the tree. This is completely redundant. </p>

</div>
</div>
<a id="af339ad528e3ed973bd454123fbded262"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af339ad528e3ed973bd454123fbded262">&#9670;&nbsp;</a></span>nItemsPerSlot</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t bwRTree_t::nItemsPerSlot</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This is always 1! </p>

</div>
</div>
<a id="ad4566d3fdd23ac4918104d23c77a7ddb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4566d3fdd23ac4918104d23c77a7ddb">&#9670;&nbsp;</a></span>root</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structbwRTreeNode__t.html">bwRTreeNode_t</a>* bwRTree_t::root</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A pointer to the root node. </p>

</div>
</div>
<a id="aa3e57a494e0c45d56dca1de0939e8197"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3e57a494e0c45d56dca1de0939e8197">&#9670;&nbsp;</a></span>rootOffset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t bwRTree_t::rootOffset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The offset to the root node of the R-Tree (on disk). Yes, this is redundant. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bwValues_8h_source.html">bwValues.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 8 2020 13:48:36 for libBigWig by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
